<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Convert terms to standardized terms based on synonyms — fixnames_aliases • EJAM</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Convert terms to standardized terms based on synonyms — fixnames_aliases"><meta name="description" content="Convert terms to standardized terms based on synonyms"><meta property="og:description" content="Convert terms to standardized terms based on synonyms"><meta property="og:image" content="https://usepa.github.io/EJAM/logo.svg"></head><body>
    <a href="#main" class="visually-hidden-focusable">Skip to contents</a>


    <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">

    <a class="navbar-brand me-2" href="../index.html">EJAM</a>

    <small class="nav-text text-warning me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Released version">2.32.0</small>


    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
      <span class="navbar-toggler-icon"></span>
    </button>

    <div id="navbar" class="collapse navbar-collapse ms-3">
      <ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="nav-item dropdown">
  <button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
  <ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>Overview for EJAM Users</h6></li>
    <li><a class="dropdown-item" href="../articles/0_whatis.html">What is EJAM</a></li>
    <li><a class="dropdown-item" href="../articles/0_webapp.html">Using EJAM</a></li>
    <li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>For analysts using R</h6></li>
    <li><a class="dropdown-item" href="../articles/1_installing.html">Installing the EJAM R package</a></li>
    <li><a class="dropdown-item" href="../articles/2_quickstart.html">Quick Start Guide</a></li>
    <li><a class="dropdown-item" href="../articles/3_analyzing.html">Basics of Using EJAM for Analysis in RStudio</a></li>
    <li><a class="dropdown-item" href="../articles/4_advanced.html">Advanced Features</a></li>
  </ul></li>
<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
      </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
 <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/USEPA/EJAM/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
      </ul></div>


  </div>
</nav><div class="container template-reference-topic">
<div class="row">
  <main id="main" class="col-md-9"><div class="page-header">
      <img src="../logo.svg" class="logo" alt=""><h1>Convert terms to standardized terms based on synonyms</h1>
      <small class="dont-index">Source: <a href="https://github.com/USEPA/EJAM/blob/HEAD/R/fixnames_aliases.R" class="external-link"><code>R/fixnames_aliases.R</code></a></small>
      <div class="d-none name"><code>fixnames_aliases.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>Convert terms to standardized terms based on synonyms</p>
    </div>

    <div class="section level2">
    <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">fixnames_aliases</span><span class="op">(</span></span>
<span>  <span class="va">x</span>,</span>
<span>  na_if_no_match <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  alias_list <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  ignore.case <span class="op">=</span> <span class="cn">TRUE</span></span>
<span><span class="op">)</span></span></code></pre></div>
    </div>

    <div class="section level2">
    <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>


<dl><dt id="arg-x">x<a class="anchor" aria-label="anchor" href="#arg-x"></a></dt>
<dd><p>vector of terms, such as colnames(testpoints_10), etc.</p></dd>


<dt id="arg-na-if-no-match">na_if_no_match<a class="anchor" aria-label="anchor" href="#arg-na-if-no-match"></a></dt>
<dd><p>optional, set to TRUE if you want it to return NA
for each element of x not found in the alias_list info</p></dd>


<dt id="arg-alias-list">alias_list<a class="anchor" aria-label="anchor" href="#arg-alias-list"></a></dt>
<dd><p>built-in already in source code (but can replace
using this optional parameter), a list of named vectors where
names are standard, preferred, canonical versions of terms, and
each vector is a set of aliases for that term.</p></dd>


<dt id="arg-ignore-case">ignore.case<a class="anchor" aria-label="anchor" href="#arg-ignore-case"></a></dt>
<dd><p>optional set to FALSE if you want to not ignore case</p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
    <p>character vector like x but where some or all may be replaced by
standardized versions of the elements of x, or NA if appropriate</p>
    </div>
    <div class="section level2">
    <h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
    <p><code><a href="fixcolnames_infer.html">fixcolnames_infer()</a></code> and <code>fixnames_aliases()</code> are very similar.</p><ul><li><p><code><a href="fixcolnames_infer.html">fixcolnames_infer()</a></code> is designed to figure out for a data.frame
which one column is the best guess (top pick) for which should be
used as the "lat" column, for example,
so when several colnames are matches based on the alias_list,
this function picks only one of them to rename to the preferred or
canonical name, leaving others as-is.</p></li>
<li><p>In contrast to that, <code>fixnames_aliases()</code> is more general and
every input element that can be matched with a
canonical name gets changed to that preferred version, so
even if multiple input names are different aliases of "lat",
for example, they all get changed to "lat."</p></li>
</ul><p>The alias_list could be for example this:</p>
<div class="sourceCode"><pre><code><span></span>
<span> <span class="va">alias_list</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span></span>
<span>  sqkm <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">'km2'</span>, <span class="st">'kilometer2'</span>,<span class="st">'kilometers2'</span>, <span class="st">'sq kilometers'</span>, <span class="st">'sq kilometer'</span>,</span>
<span>   <span class="st">'sqkilometers'</span>, <span class="st">'sqkilometer'</span>,  <span class="st">'squarekilometers'</span>, <span class="st">'squarekilometer'</span>,</span>
<span>   <span class="st">'square kilometers'</span>, <span class="st">'square kilometer'</span><span class="op">)</span>,</span>
<span>  sqm <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">'m2'</span>, <span class="st">'meter2'</span>,<span class="st">'meters2'</span>, <span class="st">'sq meters'</span>, <span class="st">'sq meter'</span>,<span class="st">'sqmeters'</span>, <span class="st">'sqmeter'</span>,</span>
<span>  <span class="st">'squaremeters'</span>, <span class="st">'squaremeter'</span>, <span class="st">'square meters'</span>, <span class="st">'square meter'</span><span class="op">)</span>,</span>
<span>  mi <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">'mile'</span>, <span class="st">'miles'</span><span class="op">)</span>,</span>
<span></span>
<span>  lat <span class="op">=</span> <span class="va">lat_alias</span>,</span>
<span>  <span class="co">#[1]"lat" "latitude83" "latitude" "latitudes"  "faclat" "lats" "y"</span></span>
<span>  lon <span class="op">=</span> <span class="va">lon_alias</span>,</span>
<span>  <span class="co">#[1]"lon" "longitude83" "longitude" "longitudes" "faclong" "lons" "long" "longs" "lng" "x"</span></span>
<span></span>
<span><span class="op">)</span></span></code></pre></div>

    </div>
    <div class="section level2">
    <h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"></a></h2>
    <div class="dont-index"><p><code><a href="fixcolnames_infer.html">fixcolnames_infer()</a></code> <code><a href="latlon_infer.html">latlon_infer()</a></code></p></div>
    </div>

    <div class="section level2">
    <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">fixnames_aliases</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"km"</span>, <span class="st">"kilometer"</span>, <span class="st">"miles"</span>, <span class="st">"statename"</span>, <span class="st">'X'</span>, <span class="st">"y"</span><span class="op">)</span><span class="op">)</span></span>
<span><span class="fu">fixnames_aliases</span><span class="op">(</span><span class="st">"LATITUDE"</span><span class="op">)</span></span>
<span><span class="fu">fixnames_aliases</span><span class="op">(</span><span class="st">"LATITUDE"</span>, ignore.case <span class="op">=</span> <span class="cn">F</span><span class="op">)</span></span>
<span><span class="fu">fixnames_aliases</span><span class="op">(</span><span class="st">"LATITUDE"</span>, na_if_no_match <span class="op">=</span> <span class="cn">T</span><span class="op">)</span></span>
<span><span class="fu">fixnames_aliases</span><span class="op">(</span><span class="st">"LATITUDE"</span>, na_if_no_match <span class="op">=</span> <span class="cn">T</span>, ignore.case <span class="op">=</span> <span class="cn">F</span><span class="op">)</span></span>
<span><span class="fu">fixnames_aliases</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="cn">NA</span>, <span class="fl">1</span>, <span class="st">"typo"</span>, <span class="fl">1</span><span class="op">:</span><span class="fl">2</span>, <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span><span class="op">)</span></span>
<span></span>
<span><span class="fu">fixnames_aliases</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">1</span><span class="op">:</span><span class="fl">4</span>, <span class="st">"na"</span>, <span class="st">"tbd"</span><span class="op">)</span>, </span>
<span>  alias_list <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span>upto1 <span class="op">=</span> <span class="fl">0</span><span class="op">:</span><span class="fl">1</span>, company <span class="op">=</span> <span class="fl">2</span>, crowd <span class="op">=</span> <span class="fl">3</span><span class="op">:</span><span class="fl">10</span>, other <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"na"</span>, <span class="st">"tbd"</span><span class="op">)</span><span class="op">)</span><span class="op">)</span></span>
<span></span></code></pre></div>
    </div>
  </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
    </nav></aside></div>


    <footer><div class="pkgdown-footer-left">
  <p>US EPA 2024</p>
</div>

<div class="pkgdown-footer-right">
  <p>EJAM Version 2.32.0</p>
</div>

    </footer></div>





  </body></html>

